Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ci: add markdown lint #16

Merged
merged 1 commit into from
Oct 16, 2024
Merged

ci: add markdown lint #16

merged 1 commit into from
Oct 16, 2024

Conversation

subhamkrai
Copy link
Contributor

@subhamkrai subhamkrai commented Jun 20, 2024 •
edited
Loading

adding markdown lint CI check and also adding some small changes
to fix the CI

MD010: false # Hard tabs
MD012: false # Multiple consecutive blank lines
MD013: false # Line length
MD019: false # Multiple spaces after hash on atx style heading
MD021: false # Multiple spaces inside hashes on closed atx style heading
MD022: false # Headings should be surrounded by blank lines
MD024: false # Multiple headings with the same content
MD025: false # Multiple top-level headings in the same document
MD027: false # Multiple spaces after blockquote symbol
MD030: false # Spaces after list markers
MD031: false # Fenced code blocks should be surrounded by blank lines
MD032: false # Lists should be surrounded by blank lines
MD041: false # First line in a file should be a top-level heading
MD043: false # Required heading structure
MD045: false # Images should have alternate text (alt text)
MD053: false # Link and image reference definitions should be needed

@subhamkrai subhamkrai mentioned this pull request Jun 20, 2024
Merged
iamniting pushed a commit to iamniting/ceph-csi-operator that referenced this pull request Aug 20, 2024
@openshift-merge-bot
Merge pull request ceph#16 from iamniting/nfs
5ff8eff 
bundle: add nfs SA to the CSV
@Madhu-1
Copy link
Collaborator

Madhu-1 commented Sep 18, 2024

@subhamkrai can you please update this PR, we have md files in the repo now.

@nb-ohad
Copy link
Collaborator

nb-ohad commented Sep 19, 2024

@subhamkrai Can we have the list of agreed rules copied from the slack discussion here? (we can have the agreed list here as a comment referring to the offline discussion we had)

@subhamkrai
Copy link
Contributor Author

@subhamkrai Can we have the list of agreed rules copied from the slack discussion here? (we can have the agreed list here as a comment referring to the offline discussion we had)

@subhamkrai can you please update this PR, we have md files in the repo now.

I missed the ping, I'll check

@subhamkrai subhamkrai force-pushed the add-md-lint branch 2 times, most recently from fa8ae62 to b61a5f4 Compare September 30, 2024 08:32
@subhamkrai subhamkrai force-pushed the add-md-lint branch 4 times, most recently from 2302721 to 448b59d Compare October 7, 2024 17:37
@subhamkrai
Copy link
Contributor Author

@Madhu-1 let me know if the changes look good, I'll mark it ready for review or I also need to fix the CI to pass the linter

@nb-ohad
Copy link
Collaborator

nb-ohad commented Oct 8, 2024

@subhamkrai the changes look good but applying the change results in CI failures.
You will need to fix the issue to allow this PR to be merged

@obnoxxx
Copy link
Collaborator

obnoxxx commented Oct 14, 2024

@subhamkrai,

just a hought:

Not sure what is the standard in this project, but wouldn't it be nice and convenient to add a make target for running markdown lint so that it can easily be invoked locally by developers
and this same make target would be invoked in the ci workflow?

@nb-ohad , @Madhu-1 - wdyt?

@Madhu-1
Copy link
Collaborator

Madhu-1 commented Oct 14, 2024

@subhamkrai,

just a hought:

Not sure what is the standard in this project, but wouldn't it be nice and convenient to add a make target for running markdown lint so that it can easily be invoked locally by developers and this same make target would be invoked in the ci workflow?

@nb-ohad , @Madhu-1 - wdyt?

@obnoxxx yes that's correct, as its a separate configuration file for md rules, we can add a new target in makefile to run it locally so that , The developer can reproduce the issue related to linter locally instead of pushing the changes to the github always to see if the issue is resolved.

@subhamkrai
ci: add markdown lint
3d2fb4e 
adding markdown lint CI check and also adding some small changes
to fix the CI

Signed-off-by: subhamkrai <[email protected]>
@subhamkrai subhamkrai marked this pull request as ready for review October 15, 2024 08:40
@nb-ohad
Copy link
Collaborator

nb-ohad commented Oct 15, 2024

@Madhu-1 We can have the work the @obnoxxx is suggesting as a separate PR after this one merges

@nb-ohad
Copy link
Collaborator

nb-ohad commented Oct 15, 2024

LGTM

@Madhu-1 Madhu-1 merged commit 71a3468 into ceph:main Oct 16, 2024
10 checks passed
@Madhu-1 Madhu-1 mentioned this pull request Oct 18, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leelavg leelavg leelavg left review comments

@Madhu-1 Madhu-1 Madhu-1 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@subhamkrai @Madhu-1 @nb-ohad @obnoxxx @leelavg